<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mutex: xmutex.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mutex
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xmutex_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xmutex.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex___config.html">XMutex_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the device.  <a href="struct_x_mutex___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_mutex.html">XMutex</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="struct_x_mutex.html" title="The XMutex driver instance data. ">XMutex</a> driver instance data.  <a href="struct_x_mutex.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacb4152fb008849bcb87006d7bd0a97a8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#gacb4152fb008849bcb87006d7bd0a97a8">XMutex_CfgInitialize</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, <a class="el" href="struct_x_mutex___config.html">XMutex_Config</a> *ConfigPtr, UINTPTR EffectiveAddress)</td></tr>
<tr class="memdesc:gacb4152fb008849bcb87006d7bd0a97a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a specific Mutex instance/driver.  <a href="group__mutex.html#gacb4152fb008849bcb87006d7bd0a97a8">More...</a><br/></td></tr>
<tr class="separator:gacb4152fb008849bcb87006d7bd0a97a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1255fbeea64f519d8def63e542ce8703"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga1255fbeea64f519d8def63e542ce8703">XMutex_Lock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr class="memdesc:ga1255fbeea64f519d8def63e542ce8703"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks a particular Mutex lock within a Mutex device.  <a href="group__mutex.html#ga1255fbeea64f519d8def63e542ce8703">More...</a><br/></td></tr>
<tr class="separator:ga1255fbeea64f519d8def63e542ce8703"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf1857cffa94ba8b3bdf491f1a0096340"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#gaf1857cffa94ba8b3bdf491f1a0096340">XMutex_Trylock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr class="memdesc:gaf1857cffa94ba8b3bdf491f1a0096340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locks a particular Mutex lock within a Mutex device.  <a href="group__mutex.html#gaf1857cffa94ba8b3bdf491f1a0096340">More...</a><br/></td></tr>
<tr class="separator:gaf1857cffa94ba8b3bdf491f1a0096340"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga82790dd21650e2b03e2c0a0f69a605d3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga82790dd21650e2b03e2c0a0f69a605d3">XMutex_Unlock</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr class="memdesc:ga82790dd21650e2b03e2c0a0f69a605d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unlocks a particular Mutex lock within a Mutex device.  <a href="group__mutex.html#ga82790dd21650e2b03e2c0a0f69a605d3">More...</a><br/></td></tr>
<tr class="separator:ga82790dd21650e2b03e2c0a0f69a605d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37302270d3c1c86dc0bffdfc7043b902"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga37302270d3c1c86dc0bffdfc7043b902">XMutex_IsLocked</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber)</td></tr>
<tr class="memdesc:ga37302270d3c1c86dc0bffdfc7043b902"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current lock state of a Mutex lock within a Mutex device.  <a href="group__mutex.html#ga37302270d3c1c86dc0bffdfc7043b902">More...</a><br/></td></tr>
<tr class="separator:ga37302270d3c1c86dc0bffdfc7043b902"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fcbb23b06dc9fb716e3812696321f66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga0fcbb23b06dc9fb716e3812696321f66">XMutex_GetStatus</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *Locked, u32 *Owner)</td></tr>
<tr class="memdesc:ga0fcbb23b06dc9fb716e3812696321f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current status of a Mutex lock within a Mutex device.  <a href="group__mutex.html#ga0fcbb23b06dc9fb716e3812696321f66">More...</a><br/></td></tr>
<tr class="separator:ga0fcbb23b06dc9fb716e3812696321f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad7d5c5cd3b24ffee6dcc093b98c8546a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#gad7d5c5cd3b24ffee6dcc093b98c8546a">XMutex_GetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 *User)</td></tr>
<tr class="memdesc:gad7d5c5cd3b24ffee6dcc093b98c8546a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the USER register of a Mutex lock within a Mutex device.  <a href="group__mutex.html#gad7d5c5cd3b24ffee6dcc093b98c8546a">More...</a><br/></td></tr>
<tr class="separator:gad7d5c5cd3b24ffee6dcc093b98c8546a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga941e13d2534884adf4926f05bae3966e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga941e13d2534884adf4926f05bae3966e">XMutex_SetUser</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr, u8 MutexNumber, u32 User)</td></tr>
<tr class="memdesc:ga941e13d2534884adf4926f05bae3966e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the USER register of a Mutex lock within a Mutex device.  <a href="group__mutex.html#ga941e13d2534884adf4926f05bae3966e">More...</a><br/></td></tr>
<tr class="separator:ga941e13d2534884adf4926f05bae3966e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1599a86dd180f3bd789a2fc472e9aa29"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mutex.html#ga1599a86dd180f3bd789a2fc472e9aa29">XMutex_SelfTest</a> (<a class="el" href="struct_x_mutex.html">XMutex</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga1599a86dd180f3bd789a2fc472e9aa29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selftest a particular Mutex hardware core.  <a href="group__mutex.html#ga1599a86dd180f3bd789a2fc472e9aa29">More...</a><br/></td></tr>
<tr class="separator:ga1599a86dd180f3bd789a2fc472e9aa29"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
